@casual-simulation/aux-common

AUX Common

A library that contains common operations needed to modify and understand AUX files.

Installation

$ npm install @casual-simulation/aux-common

Usage

Calculate a formula for some bots

import {
    createBot,
    createCalculationContext,
    calculateFormulaValue,
} from '@casual-simulation/aux-common';

const file1 = createBot('test1', {
    quantity: 10,
});
const file2 = createBot('test2', {
    quantity: 5,
});
const file3 = createBot('test3', {
    quantity: 5,
});

const context = createCalculationContext([file1, file2, file3]);

const formula = '=math.sum(getBotTagValues("#quantity"))';
const result = calculateFormulaValue(context, formula);

console.log(result);

// Outputs:
// 20

Calculate events for an action script

import {
    createBot,
    createCalculationContext,
    calculateFormulaEvents,
} from '@casual-simulation/aux-common';

const state = {
    test1: createBot('test1', {
        quantity: 10,
    }),
    test2: createBot('test2', {
        quantity: 5,
    }),
    test3: createBot('test3', {
        quantity: 5,
    }),
};

const formula = `
    let total = math.sum(getBotTagValues("#quantity"));
    player.toast("The total is " + total);
`;
const events = calculateFormulaEvents(state, formula);

for (let event of events) {
    if (event.type === 'local') {
        if (event.name === 'show_toast') {
            console.log('[Toast]', event.message);
        }
    }
}

// Outputs:
// [Toast] The total is 5

Changelog

V0.11.27

Date: 2/6/2020

Changes:

:rocket: Features

• Added an initial version of Builder.
  • Builder is a bot that helps you build things in aux.
  • Builder lives in the auxBuilder dimension and can be woken up by clicking it.
  • Builder currently has the following chat commands:
    • .. [name] - Wakes Builder with the given name. If the name is omitted, then the b001 Builder will be woken.
    • .sleep - Puts Builder to sleep.
    • .sheet [dimension] - Opens the sheet to the given dimension. If the dimension is omitted, then the sheet will be opened for the current dimension.
    • .new bot - Creates a new bot in the current dimension.
    • .download - Downloads the entire universe.
    • .upload - Shows the upload dialog.
    • .goto {dimension} - Redirects the page portal to the given dimension.
    • .new universe {universeName} - Creates a new universe with the given name and opens it in a new tab.
    • .show history - Loads the history and goes to the auxHistory dimension.
    • .mark history - Creates a new history mark for the current state.
    • .show docs - Opens the documentation website in a new tab.
    • .summon - Summons the Builder helper into the current dimension.
    • .new builder {name} - Creates a clone of the current builder with the given name.
  • Builder has a helper bot which will follow you around the universe.
    • If you enter an empty dimension, the helper bot will automatically appear.
    • If you enter a dimension that has a bot, you need to summon it using the .summon command.
    • You can click on helper to show a menu of possible options.
    • Dragging helper will give you a cursor that lets you teleport helper around or select other bots.
    • Dragging another bot onto helper will turn helper into a pallete so when you drag helper it will make a clone of the other bot.
      • Clicking helper will return it to normal.
• Added hotkeys to show/hide the chat bar.
  • Use the ~ key to show the char bar.
  • Use the 3342 finger tap code on mobile to show the chat bar.
  • Use a 5 finger tap on mobile to hide the chat bar.

:bug: Bug Fixes

• Fixed an issue where creating a bot inside a shout would prevent the new bot from being modified by future shouts.
• Fixed an issue where creating and then updating a bot that was not in the shared space would cause all the updates to be incorrectly routed to the shared space and dropped.